/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.common;

import org.hisp.dhis.feedback.ErrorCode;
import org.hisp.dhis.feedback.ErrorMessage;

/**
 * Runtime exception which references an {@link ErrorCode}.
 *
 * @author Lars Helge Overland
 */
public class ErrorCodeException extends RuntimeException {
  private final ErrorCode errorCode;

  /** Deprecated, use {@link ErrorCode} or {@ErrorMessage} constructors instead. */
  public ErrorCodeException(String message) {
    super(message);
    this.errorCode = null;
  }

  /**
   * Constructor.
   *
   * @param errorCode the {@link ErrorCode}.
   */
  public ErrorCodeException(ErrorCode errorCode) {
    super(errorCode.getMessage());
    this.errorCode = errorCode;
  }

  /**
   * Constructor.
   *
   * @param errorMessage the {@link ErrorMessage}.
   */
  public ErrorCodeException(ErrorMessage errorMessage) {
    super(errorMessage.getMessage());
    this.errorCode = errorMessage.getErrorCode();
  }

  /**
   * Constructor.
   *
   * @param errorCode the {@link ErrorCode}.
   * @param args the message format arguments.
   */
  public ErrorCodeException(ErrorCode errorCode, Object... args) {
    this(new ErrorMessage(errorCode, args));
  }

  /**
   * Returns the {@link ErrorCode} of the exception.
   *
   * @return the {@link ErrorCode} of the exception.
   */
  public ErrorCode getErrorCode() {
    return errorCode;
  }
}
